[24.0] Fix search and version menu in docs #17898
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `html_theme_path` option should not be used any more with sphinx-rtd-theme since it switches off the theme's ability to automatically enable the sphinxcontrib-jquery extension, i.e. jQuery is not loaded in the web pages when building the docs with Sphinx >=6. xref: readthedocs/sphinx_rtd_theme#1434 (comment) Also replace the deprecated `canonical_url` theme option with Sphinx's `html_baseurl`. xref: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-canonical_url
|
I was wondering about the missing jquery console error, thanks @nsoranzo ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
html_theme_pathoption should not be used any more with sphinx-rtd-theme since it switches off the theme's ability to automatically enable the sphinxcontrib-jquery extension, i.e. jQuery is not loaded in the web pages when building the docs with Sphinx >=6.xref: readthedocs/sphinx_rtd_theme#1434 (comment)
Also replace the deprecated
canonical_urltheme option with Sphinx'shtml_baseurl.xref: https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-canonical_url
How to test the changes?
(Select all options that apply)
cat doc/source/conf.versioning.py >> doc/source/conf.pyTARGET_BRANCH=release_24.0 make docs-developfirefox doc/build/html/index.htmlLicense